Update admonition title syntax #145
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Dan Barr <[email protected]>
Signed-off-by: Dan Barr <[email protected]>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR updates the admonition title syntax across the documentation to use the new MDX v3 format with square brackets, while disabling MDX v1 compatibility options for comments and admonitions in Docusaurus configuration.
Key changes:
- Disables MDX v1 compatibility for comments and admonitions in
docusaurus.config.ts - Updates all admonition titles from the old syntax (e.g.,
:::info What is this?) to the new square bracket syntax (e.g.,:::info[What is this?]) - Updates documentation guidelines to reflect the new admonition syntax requirements
Reviewed Changes
Copilot reviewed 21 out of 21 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| docusaurus.config.ts | Adds MDX v1 compatibility configuration to disable old comment and admonition syntax |
| docs/toolhive/tutorials/quickstart-ui.mdx | Updates 4 info admonitions to use square bracket title syntax |
| docs/toolhive/tutorials/quickstart-k8s.mdx | Updates 6 info admonitions and 1 tip admonition to use square bracket syntax |
| docs/toolhive/tutorials/quickstart-cli.mdx | Updates 5 info admonitions to use square bracket title syntax |
| docs/toolhive/guides-ui/secrets-management.md | Changes admonition type from important to warning (no title) |
| docs/toolhive/guides-ui/network-isolation.mdx | Changes important admonition to info[Important] with title |
| docs/toolhive/guides-ui/install.mdx | Changes important admonition to info[Important] with title |
| docs/toolhive/guides-ui/index.mdx | Updates tip admonition to use square bracket title syntax |
| docs/toolhive/guides-k8s/run-mcp-k8s.md | Updates 3 info admonitions to use square bracket syntax |
| docs/toolhive/guides-k8s/intro.md | Updates experimental info admonition to use square bracket syntax |
| docs/toolhive/guides-cli/telemetry-and-metrics.md | Updates tip admonition to use square bracket title syntax |
| docs/toolhive/guides-cli/secrets-management.mdx | Updates tip admonition to use square bracket title syntax |
| docs/toolhive/guides-cli/run-mcp-servers.mdx | Updates 3 info admonitions to use square bracket syntax |
| docs/toolhive/guides-cli/network-isolation.mdx | Changes important admonition to info[Important] with title |
| docs/toolhive/guides-cli/index.mdx | Updates tip admonition to use square bracket title syntax |
| docs/toolhive/guides-cli/group-management.md | Updates 2 info admonitions to use square bracket syntax |
| docs/toolhive/guides-cli/custom-permissions.mdx | Changes important admonition to info[Important] with title |
| docs/toolhive/guides-cli/build-containers.mdx | Updates info admonition to use square bracket title syntax |
| docs/theme-preview.mdx | Updates example admonitions and adds documentation about new syntax |
| CLAUDE.md | Updates admonition syntax guidelines in coding instructions |
| .github/copilot-instructions.md | Updates admonition syntax guidelines in GitHub Copilot instructions |
rdimitrov
approved these changes
Aug 27, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Disables the MDX v1 compatibility options for comments and admonitions.
This requires the updated admonition title syntax using square brackets.
See https://docusaurus.io/docs/migration/v3#turn-off-mdx-v1-compat
Signed-off-by: Dan Barr [email protected]